<!doctype html>
<html class="default no-js">
<head>
	<meta charset="utf-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
	<title>ChangeStreamDocument | mongodb</title>
	<meta name="description" content="Documentation for mongodb">
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<link rel="stylesheet" href="../assets/css/main.css">
	<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
	<div class="tsd-page-toolbar">
		<div class="container">
			<div class="table-wrap">
				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
					<div class="field">
						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
						<input id="tsd-search-field" type="text" />
					</div>
					<ul class="results">
						<li class="state loading">Preparing search index...</li>
						<li class="state failure">The search index is not available</li>
					</ul>
					<a href="../index.html" class="title">mongodb</a>
				</div>
				<div class="table-cell" id="tsd-widgets">
					<div id="tsd-filter">
						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
						<div class="tsd-filter-group">
							<div class="tsd-select" id="tsd-filter-visibility">
								<span class="tsd-select-label">All</span>
								<ul class="tsd-select-list">
									<li data-value="public">Public</li>
									<li data-value="protected">Public/Protected</li>
									<li data-value="private" class="selected">All</li>
								</ul>
							</div>
							<input type="checkbox" id="tsd-filter-inherited" checked />
							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
							<input type="checkbox" id="tsd-filter-externals" checked />
							<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
						</div>
					</div>
					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
				</div>
			</div>
		</div>
	</div>
	<div class="tsd-page-title">
		<div class="container">
			<ul class="tsd-breadcrumb">
				<li>
					<a href="../modules.html">mongodb</a>
				</li>
				<li>
					<a href="ChangeStreamDocument.html">ChangeStreamDocument</a>
				</li>
			</ul>
			<h1>Interface ChangeStreamDocument&lt;TSchema&gt;</h1>
		</div>
	</div>
</header>
<div class="container container-main">
	<div class="row">
		<div class="col-8 col-content">
			<section class="tsd-panel tsd-type-parameters">
				<h3>Type parameters</h3>
				<ul class="tsd-type-parameters">
					<li>
						<h4>TSchema<span class="tsd-signature-symbol">: </span><a href="Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a> = <a href="Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a></h4>
					</li>
				</ul>
			</section>
			<section class="tsd-panel tsd-hierarchy">
				<h3>Hierarchy</h3>
				<ul class="tsd-hierarchy">
					<li>
						<span class="target">ChangeStreamDocument</span>
					</li>
				</ul>
			</section>
			<section class="tsd-panel-group tsd-index-group">
				<h2>Index</h2>
				<section class="tsd-panel tsd-index-panel">
					<div class="tsd-index-content">
						<section class="tsd-index-section ">
							<h3>Properties</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChangeStreamDocument.html#_id" class="tsd-kind-icon">_id</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChangeStreamDocument.html#documentKey" class="tsd-kind-icon">document<wbr>Key</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChangeStreamDocument.html#fullDocument" class="tsd-kind-icon">full<wbr>Document</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChangeStreamDocument.html#ns" class="tsd-kind-icon">ns</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChangeStreamDocument.html#operationType" class="tsd-kind-icon">operation<wbr>Type</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChangeStreamDocument.html#updateDescription" class="tsd-kind-icon">update<wbr>Description</a></li>
							</ul>
						</section>
					</div>
				</section>
			</section>
			<section class="tsd-panel-group tsd-member-group ">
				<h2>Properties</h2>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="_id" class="tsd-anchor"></a>
					<h3>_id</h3>
					<div class="tsd-signature tsd-kind-icon">_id<span class="tsd-signature-symbol">:</span> <a href="../modules.html#InferIdType" class="tsd-signature-type" data-tsd-kind="Type alias">InferIdType</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">&gt;</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/c9a962f1/src/change_stream.ts#L116">src/change_stream.ts:116</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>The id functions as an opaque token for use when resuming an interrupted
							change stream.</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="documentKey" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> document<wbr>Key</h3>
					<div class="tsd-signature tsd-kind-icon">document<wbr>Key<span class="tsd-signature-symbol">:</span> <a href="../modules.html#InferIdType" class="tsd-signature-type" data-tsd-kind="Type alias">InferIdType</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">&gt;</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/c9a962f1/src/change_stream.ts#L146">src/change_stream.ts:146</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Only present for ops of type ‘insert’, ‘update’, ‘replace’, and
							‘delete’.</p>
						</div>
						<p>For unsharded collections this contains a single field, _id, with the
							value of the _id of the document updated.  For sharded collections,
							this will contain all the components of the shard key in order,
						followed by the _id if the _id isn’t part of the shard key.</p>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="fullDocument" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> full<wbr>Document</h3>
					<div class="tsd-signature tsd-kind-icon">full<wbr>Document<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TSchema</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/c9a962f1/src/change_stream.ts#L169">src/change_stream.ts:169</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Always present for operations of type ‘insert’ and ‘replace’. Also
								present for operations of type ‘update’ if the user has specified ‘updateLookup’
							in the ‘fullDocument’ arguments to the ‘$changeStream’ stage.</p>
						</div>
						<p>For operations of type ‘insert’ and ‘replace’, this key will contain the
							document being inserted, or the new version of the document that is replacing
						the existing document, respectively.</p>
						<p>For operations of type ‘update’, this key will contain a copy of the full
							version of the document from some point after the update occurred. If the
						document was deleted since the updated happened, it will be null.</p>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="ns" class="tsd-anchor"></a>
					<h3>ns</h3>
					<div class="tsd-signature tsd-kind-icon">ns<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>coll<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>db<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/c9a962f1/src/change_stream.ts#L135">src/change_stream.ts:135</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Contains two fields: “db” and “coll” containing the database and
							collection name in which the change happened.</p>
						</div>
					</div>
					<div class="tsd-type-declaration">
						<h4>Type declaration</h4>
						<ul class="tsd-parameters">
							<li class="tsd-parameter">
								<h5>coll<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
							</li>
							<li class="tsd-parameter">
								<h5>db<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
							</li>
						</ul>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="operationType" class="tsd-anchor"></a>
					<h3>operation<wbr>Type</h3>
					<div class="tsd-signature tsd-kind-icon">operation<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;insert&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;update&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;replace&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;delete&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;invalidate&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;drop&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;dropDatabase&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;rename&quot;</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/c9a962f1/src/change_stream.ts#L121">src/change_stream.ts:121</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Describes the type of operation represented in this change notification.</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="updateDescription" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> update<wbr>Description</h3>
					<div class="tsd-signature tsd-kind-icon">update<wbr>Description<span class="tsd-signature-symbol">:</span> <a href="UpdateDescription.html" class="tsd-signature-type" data-tsd-kind="Interface">UpdateDescription</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">&gt;</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/c9a962f1/src/change_stream.ts#L154">src/change_stream.ts:154</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Only present for ops of type ‘update’.</p>
						</div>
						<p>Contains a description of updated and removed fields in this
						operation.</p>
					</div>
				</section>
			</section>
		</div>
		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
			<nav class="tsd-navigation primary">
				<ul>
					<li class=" ">
						<a href="../modules.html">Exports</a>
					</li>
				</ul>
			</nav>
			<nav class="tsd-navigation secondary menu-sticky">
				<ul class="before-current">
				</ul>
				<ul class="current">
					<li class="current tsd-kind-interface tsd-has-type-parameter">
						<a href="ChangeStreamDocument.html" class="tsd-kind-icon">Change<wbr>Stream<wbr>Document</a>
						<ul>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="ChangeStreamDocument.html#_id" class="tsd-kind-icon">_id</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="ChangeStreamDocument.html#documentKey" class="tsd-kind-icon">document<wbr>Key</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="ChangeStreamDocument.html#fullDocument" class="tsd-kind-icon">full<wbr>Document</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="ChangeStreamDocument.html#ns" class="tsd-kind-icon">ns</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="ChangeStreamDocument.html#operationType" class="tsd-kind-icon">operation<wbr>Type</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="ChangeStreamDocument.html#updateDescription" class="tsd-kind-icon">update<wbr>Description</a>
							</li>
						</ul>
					</li>
				</ul>
				<ul class="after-current">
				</ul>
			</nav>
		</div>
	</div>
</div>
<footer class="with-border-bottom">
	<div class="container">
		<h2>Legend</h2>
		<div class="tsd-legend-group">
			<ul class="tsd-legend">
				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
			</ul>
		</div>
	</div>
</footer>
<div class="container tsd-generator">
	<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>